\hypertarget{class_yig}{
\section{Yig Class Reference}
\label{class_yig}\index{Yig@{Yig}}
}


{\ttfamily \#include $<$yig.h$>$}

\subsection*{Public Slots}
\begin{DoxyCompactItemize}
\item 
void \hyperlink{class_yig_a4e3f3ea4a7260f565b15ba547f582f0b}{createSynthMenu} ()
\item 
void \hyperlink{class_yig_aef57ede2cf9de6002460abf3438ca8c6}{handleQuit} ()
\item 
void \hyperlink{class_yig_a3fbd1f7f4697cf3d1dc15f6687b80025}{finishQuit} ()
\end{DoxyCompactItemize}
\subsection*{Signals}
\begin{DoxyCompactItemize}
\item 
void \hyperlink{class_yig_a6af62fd5cf65ec9cb92c51c185b67790}{quitting} ()
\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{class_yig_a2f4f0e10e75cdcc33deea815238a9baf}{Yig} (\hyperlink{class_yig_client}{YigClient} $\ast$yigClient, int oscthulhuPort, QString userName, \hyperlink{class_s_c_lang}{SCLang} $\ast$scLang, QSemaphore $\ast$wait4CleanupDone)
\item 
\hyperlink{class_yig_a5b65aa4a0052e56d94e5eb4bf35e749a}{$\sim$Yig} ()
\item 
void \hyperlink{class_yig_a9e7eca3f9b60bf96b04d4350bfb7e89e}{setActiveChannel} (int channelNum)
\item 
void \hyperlink{class_yig_a336ee585653bf6bd2525f82d6259c49d}{sendCthulhu} (const char $\ast$command)
\item 
void \hyperlink{class_yig_ae5a1bd42d8b02c46581e7acdbaa9a9f0}{sendCthulhu} (const char $\ast$command, const char $\ast$value)
\item 
void \hyperlink{class_yig_a49b84b0b7d1d03d1e5768bb41ba660ee}{sendCthulhu} (const char $\ast$command, int value)
\item 
void \hyperlink{class_yig_a3eb8dc48a808e44915cbfe70f4689d59}{sendCthulhu} (const char $\ast$command, float value)
\item 
void \hyperlink{class_yig_ae30e92a5dd69f6e9fd0d3c752ea9e9a3}{requestCreateSynth} (const char $\ast$mapKey, int xPos, int yPos)
\item 
void \hyperlink{class_yig_afad21c82f602f1746e0ad9e89a9eec67}{requestDeleteSynth} (const char $\ast$mapKey)
\end{DoxyCompactItemize}
\subsection*{Static Public Attributes}
\begin{DoxyCompactItemize}
\item 
static const int \hyperlink{class_yig_a676f5ffb5e43a43a55b956376142846b}{NUMBER\_\-OF\_\-NETWORK\_\-CHANNELS} = 1
\end{DoxyCompactItemize}


\subsection{Detailed Description}
Main class that organizes the various higher level elements of the program 

\subsection{Constructor \& Destructor Documentation}
\hypertarget{class_yig_a2f4f0e10e75cdcc33deea815238a9baf}{
\index{Yig@{Yig}!Yig@{Yig}}
\index{Yig@{Yig}!Yig@{Yig}}
\subsubsection[{Yig}]{\setlength{\rightskip}{0pt plus 5cm}Yig::Yig ({\bf YigClient} $\ast$ {\em yigClient}, \/  int {\em oscthulhuPort}, \/  QString {\em userName}, \/  {\bf SCLang} $\ast$ {\em scLang}, \/  QSemaphore $\ast$ {\em wait4CleanupDone})}}
\label{class_yig_a2f4f0e10e75cdcc33deea815238a9baf}
\hyperlink{class_yig}{Yig} constructor 
\begin{DoxyParams}{Parameters}
\item[{\em YigClient$\ast$}]yigClient osc networking client \item[{\em int}]OSCthulhu port The port to send messages to for oscthulhu networking \item[{\em QString}]userName The name of the local user \item[{\em SCLang$\ast$}]scLang Pointer to the instance of sc lang we are using \item[{\em QSemaphore$\ast$}]a pointer to a semaphore that ensures proper clean up \end{DoxyParams}
\hypertarget{class_yig_a5b65aa4a0052e56d94e5eb4bf35e749a}{
\index{Yig@{Yig}!$\sim$Yig@{$\sim$Yig}}
\index{$\sim$Yig@{$\sim$Yig}!Yig@{Yig}}
\subsubsection[{$\sim$Yig}]{\setlength{\rightskip}{0pt plus 5cm}Yig::$\sim$Yig ()}}
\label{class_yig_a5b65aa4a0052e56d94e5eb4bf35e749a}
\hyperlink{class_yig}{Yig} Deconstructor, kill yo pointerz f00 

\subsection{Member Function Documentation}
\hypertarget{class_yig_a4e3f3ea4a7260f565b15ba547f582f0b}{
\index{Yig@{Yig}!createSynthMenu@{createSynthMenu}}
\index{createSynthMenu@{createSynthMenu}!Yig@{Yig}}
\subsubsection[{createSynthMenu}]{\setlength{\rightskip}{0pt plus 5cm}void Yig::createSynthMenu ()\hspace{0.3cm}{\ttfamily  \mbox{[}slot\mbox{]}}}}
\label{class_yig_a4e3f3ea4a7260f565b15ba547f582f0b}
creates the synth menu, called once the sc synth server has booted \hypertarget{class_yig_a3fbd1f7f4697cf3d1dc15f6687b80025}{
\index{Yig@{Yig}!finishQuit@{finishQuit}}
\index{finishQuit@{finishQuit}!Yig@{Yig}}
\subsubsection[{finishQuit}]{\setlength{\rightskip}{0pt plus 5cm}void Yig::finishQuit ()\hspace{0.3cm}{\ttfamily  \mbox{[}slot\mbox{]}}}}
\label{class_yig_a3fbd1f7f4697cf3d1dc15f6687b80025}
once everything has cleaned up we finalize the quitting process by freeing the semaphore \hypertarget{class_yig_aef57ede2cf9de6002460abf3438ca8c6}{
\index{Yig@{Yig}!handleQuit@{handleQuit}}
\index{handleQuit@{handleQuit}!Yig@{Yig}}
\subsubsection[{handleQuit}]{\setlength{\rightskip}{0pt plus 5cm}void Yig::handleQuit ()\hspace{0.3cm}{\ttfamily  \mbox{[}slot\mbox{]}}}}
\label{class_yig_aef57ede2cf9de6002460abf3438ca8c6}
This is called when the main application is attempting to quit, allowing us to clean up threads and such \hypertarget{class_yig_a6af62fd5cf65ec9cb92c51c185b67790}{
\index{Yig@{Yig}!quitting@{quitting}}
\index{quitting@{quitting}!Yig@{Yig}}
\subsubsection[{quitting}]{\setlength{\rightskip}{0pt plus 5cm}void Yig::quitting ()\hspace{0.3cm}{\ttfamily  \mbox{[}signal\mbox{]}}}}
\label{class_yig_a6af62fd5cf65ec9cb92c51c185b67790}
Emitted when \hyperlink{class_yig}{Yig} is itself quitting \hypertarget{class_yig_ae30e92a5dd69f6e9fd0d3c752ea9e9a3}{
\index{Yig@{Yig}!requestCreateSynth@{requestCreateSynth}}
\index{requestCreateSynth@{requestCreateSynth}!Yig@{Yig}}
\subsubsection[{requestCreateSynth}]{\setlength{\rightskip}{0pt plus 5cm}void Yig::requestCreateSynth (const char $\ast$ {\em mapKey}, \/  int {\em xPos}, \/  int {\em yPos})}}
\label{class_yig_ae30e92a5dd69f6e9fd0d3c752ea9e9a3}
requestCreateSynth Request the oscthulhu server to create a new synth 
\begin{DoxyParams}{Parameters}
\item[{\em const}]char$\ast$ mapKey The map key for the synth to be created \item[{\em int}]xPos The x coordinate for the synth in the gui \item[{\em int}]yPos The y coordinate for the synth in the gui \end{DoxyParams}
\hypertarget{class_yig_afad21c82f602f1746e0ad9e89a9eec67}{
\index{Yig@{Yig}!requestDeleteSynth@{requestDeleteSynth}}
\index{requestDeleteSynth@{requestDeleteSynth}!Yig@{Yig}}
\subsubsection[{requestDeleteSynth}]{\setlength{\rightskip}{0pt plus 5cm}void Yig::requestDeleteSynth (const char $\ast$ {\em mapKey})}}
\label{class_yig_afad21c82f602f1746e0ad9e89a9eec67}
requestDeleteSynth Request the oscthulhu server to delete a synth 
\begin{DoxyParams}{Parameters}
\item[{\em const}]char$\ast$ mapKey The map key for the synth to be deleted \end{DoxyParams}
\hypertarget{class_yig_a3eb8dc48a808e44915cbfe70f4689d59}{
\index{Yig@{Yig}!sendCthulhu@{sendCthulhu}}
\index{sendCthulhu@{sendCthulhu}!Yig@{Yig}}
\subsubsection[{sendCthulhu}]{\setlength{\rightskip}{0pt plus 5cm}void Yig::sendCthulhu (const char $\ast$ {\em command}, \/  float {\em value})}}
\label{class_yig_a3eb8dc48a808e44915cbfe70f4689d59}
sendCthulhu sends takes a command, packages it as an osc packet and gives it to the client to send to OSCthulhu 
\begin{DoxyParams}{Parameters}
\item[{\em float}]command The command as a float to be sent to the local OSCthulhu client over osc \end{DoxyParams}
\hypertarget{class_yig_a49b84b0b7d1d03d1e5768bb41ba660ee}{
\index{Yig@{Yig}!sendCthulhu@{sendCthulhu}}
\index{sendCthulhu@{sendCthulhu}!Yig@{Yig}}
\subsubsection[{sendCthulhu}]{\setlength{\rightskip}{0pt plus 5cm}void Yig::sendCthulhu (const char $\ast$ {\em command}, \/  int {\em value})}}
\label{class_yig_a49b84b0b7d1d03d1e5768bb41ba660ee}
sendCthulhu sends takes a command, packages it as an osc packet and gives it to the client to send to OSCthulhu 
\begin{DoxyParams}{Parameters}
\item[{\em cont}]char$\ast$ command The command as a string to be sent to the local OSCthulhu client over osc \item[{\em int}]value The value as an int to be sent \end{DoxyParams}
\hypertarget{class_yig_ae5a1bd42d8b02c46581e7acdbaa9a9f0}{
\index{Yig@{Yig}!sendCthulhu@{sendCthulhu}}
\index{sendCthulhu@{sendCthulhu}!Yig@{Yig}}
\subsubsection[{sendCthulhu}]{\setlength{\rightskip}{0pt plus 5cm}void Yig::sendCthulhu (const char $\ast$ {\em command}, \/  const char $\ast$ {\em value})}}
\label{class_yig_ae5a1bd42d8b02c46581e7acdbaa9a9f0}
sendCthulhu sends takes a command, packages it as an osc packet and gives it to the client to send to OSCthulhu 
\begin{DoxyParams}{Parameters}
\item[{\em cont}]char$\ast$ command The command as a string to be sent to the local OSCthulhu client over osc \item[{\em cont}]char$\ast$ value The value as an int to be sent \end{DoxyParams}
\hypertarget{class_yig_a336ee585653bf6bd2525f82d6259c49d}{
\index{Yig@{Yig}!sendCthulhu@{sendCthulhu}}
\index{sendCthulhu@{sendCthulhu}!Yig@{Yig}}
\subsubsection[{sendCthulhu}]{\setlength{\rightskip}{0pt plus 5cm}void Yig::sendCthulhu (const char $\ast$ {\em command})}}
\label{class_yig_a336ee585653bf6bd2525f82d6259c49d}
sendCthulhu sends takes a command, packages it as an osc packet and gives it to the client to send to OSCthulhu 
\begin{DoxyParams}{Parameters}
\item[{\em cont}]char$\ast$ command The command as a string to be sent to the local OSCthulhu client over osc \end{DoxyParams}
\hypertarget{class_yig_a9e7eca3f9b60bf96b04d4350bfb7e89e}{
\index{Yig@{Yig}!setActiveChannel@{setActiveChannel}}
\index{setActiveChannel@{setActiveChannel}!Yig@{Yig}}
\subsubsection[{setActiveChannel}]{\setlength{\rightskip}{0pt plus 5cm}void Yig::setActiveChannel (int {\em channelNum})}}
\label{class_yig_a9e7eca3f9b60bf96b04d4350bfb7e89e}
setActiveChannel Sets the active channel which effects drag/drop ability and interactivity 
\begin{DoxyParams}{Parameters}
\item[{\em int}]channelNum Number of the active channel and channelView \end{DoxyParams}


\subsection{Member Data Documentation}
\hypertarget{class_yig_a676f5ffb5e43a43a55b956376142846b}{
\index{Yig@{Yig}!NUMBER\_\-OF\_\-NETWORK\_\-CHANNELS@{NUMBER\_\-OF\_\-NETWORK\_\-CHANNELS}}
\index{NUMBER\_\-OF\_\-NETWORK\_\-CHANNELS@{NUMBER\_\-OF\_\-NETWORK\_\-CHANNELS}!Yig@{Yig}}
\subsubsection[{NUMBER\_\-OF\_\-NETWORK\_\-CHANNELS}]{\setlength{\rightskip}{0pt plus 5cm}const int {\bf Yig::NUMBER\_\-OF\_\-NETWORK\_\-CHANNELS} = 1\hspace{0.3cm}{\ttfamily  \mbox{[}static\mbox{]}}}}
\label{class_yig_a676f5ffb5e43a43a55b956376142846b}
The number of network channels in \hyperlink{class_yig}{Yig}. Right now it is 1. We want 4 channels, however it will have to be worked out how to have 4 different YigNetworkChannels, and only 1 \hyperlink{class_yig_network_channel_view}{YigNetworkChannelView} 

The documentation for this class was generated from the following files:\begin{DoxyCompactItemize}
\item 
yig.h\item 
yig.cpp\end{DoxyCompactItemize}
